@typedtrader/exchange 0.2.4 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +89 -0
- package/dist/broker/Broker.d.ts +152 -0
- package/dist/broker/Broker.js +124 -0
- package/dist/broker/Broker.js.map +1 -0
- package/dist/broker/BrokerMock.d.ts +51 -0
- package/dist/broker/BrokerMock.js +333 -0
- package/dist/broker/BrokerMock.js.map +1 -0
- package/dist/broker/MarketDataSource.d.ts +11 -0
- package/dist/broker/MarketDataSource.js +26 -0
- package/dist/broker/MarketDataSource.js.map +1 -0
- package/dist/broker/TradingPair.d.ts +12 -0
- package/dist/broker/TradingPair.js +22 -0
- package/dist/broker/TradingPair.js.map +1 -0
- package/dist/broker/alpaca/AlpacaBroker.d.ts +49 -0
- package/dist/broker/alpaca/AlpacaBroker.js +258 -0
- package/dist/broker/alpaca/AlpacaBroker.js.map +1 -0
- package/dist/broker/alpaca/AlpacaBrokerMapper.d.ts +12 -0
- package/dist/broker/alpaca/AlpacaBrokerMapper.js +96 -0
- package/dist/broker/alpaca/AlpacaBrokerMapper.js.map +1 -0
- package/dist/broker/alpaca/AlpacaBrokerMock.d.ts +15 -0
- package/dist/broker/alpaca/AlpacaBrokerMock.js +29 -0
- package/dist/broker/alpaca/AlpacaBrokerMock.js.map +1 -0
- package/dist/broker/alpaca/AlpacaMarketData.d.ts +19 -0
- package/dist/broker/alpaca/AlpacaMarketData.js +130 -0
- package/dist/broker/alpaca/AlpacaMarketData.js.map +1 -0
- package/dist/broker/alpaca/AlpacaTradingWebSocket.d.ts +15 -0
- package/dist/broker/alpaca/AlpacaTradingWebSocket.js +95 -0
- package/dist/broker/alpaca/AlpacaTradingWebSocket.js.map +1 -0
- package/dist/broker/alpaca/AlpacaWebSocket.d.ts +14 -0
- package/dist/broker/alpaca/AlpacaWebSocket.js +93 -0
- package/dist/broker/alpaca/AlpacaWebSocket.js.map +1 -0
- package/dist/broker/alpaca/alpacaSymbol.d.ts +4 -0
- package/dist/broker/alpaca/alpacaSymbol.js +20 -0
- package/dist/broker/alpaca/alpacaSymbol.js.map +1 -0
- package/dist/broker/alpaca/api/AlpacaAPI.d.ts +277 -0
- package/dist/broker/alpaca/api/AlpacaAPI.js +108 -0
- package/dist/broker/alpaca/api/AlpacaAPI.js.map +1 -0
- package/dist/broker/alpaca/api/AlpacaStream.d.ts +13 -0
- package/dist/broker/alpaca/api/AlpacaStream.js +61 -0
- package/dist/broker/alpaca/api/AlpacaStream.js.map +1 -0
- package/dist/broker/alpaca/api/AlpacaTradingStream.d.ts +12 -0
- package/dist/broker/alpaca/api/AlpacaTradingStream.js +59 -0
- package/dist/broker/alpaca/api/AlpacaTradingStream.js.map +1 -0
- package/dist/broker/alpaca/api/schema/AccountSchema.d.ts +26 -0
- package/dist/broker/alpaca/api/schema/AccountSchema.js +26 -0
- package/dist/broker/alpaca/api/schema/AccountSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/AssetSchema.d.ts +19 -0
- package/dist/broker/alpaca/api/schema/AssetSchema.js +19 -0
- package/dist/broker/alpaca/api/schema/AssetSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/BarSchema.d.ts +37 -0
- package/dist/broker/alpaca/api/schema/BarSchema.js +19 -0
- package/dist/broker/alpaca/api/schema/BarSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/ClockSchema.d.ts +7 -0
- package/dist/broker/alpaca/api/schema/ClockSchema.js +8 -0
- package/dist/broker/alpaca/api/schema/ClockSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/OrderSchema.d.ts +78 -0
- package/dist/broker/alpaca/api/schema/OrderSchema.js +73 -0
- package/dist/broker/alpaca/api/schema/OrderSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/PositionSchema.d.ts +31 -0
- package/dist/broker/alpaca/api/schema/PositionSchema.js +23 -0
- package/dist/broker/alpaca/api/schema/PositionSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/SnapshotSchema.d.ts +82 -0
- package/dist/broker/alpaca/api/schema/SnapshotSchema.js +15 -0
- package/dist/broker/alpaca/api/schema/SnapshotSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/StreamSchema.d.ts +48 -0
- package/dist/broker/alpaca/api/schema/StreamSchema.js +32 -0
- package/dist/broker/alpaca/api/schema/StreamSchema.js.map +1 -0
- package/dist/broker/alpaca/api/schema/TradingStreamSchema.d.ts +61 -0
- package/dist/broker/alpaca/api/schema/TradingStreamSchema.js +30 -0
- package/dist/broker/alpaca/api/schema/TradingStreamSchema.js.map +1 -0
- package/dist/broker/alpaca/getAlpacaClient.d.ts +8 -0
- package/dist/broker/alpaca/getAlpacaClient.js +29 -0
- package/dist/broker/alpaca/getAlpacaClient.js.map +1 -0
- package/dist/broker/alpaca/getAlpacaMarketData.d.ts +2 -0
- package/dist/broker/alpaca/getAlpacaMarketData.js +12 -0
- package/dist/broker/alpaca/getAlpacaMarketData.js.map +1 -0
- package/dist/broker/alpaca/getAlpacaRules.d.ts +11 -0
- package/dist/broker/alpaca/getAlpacaRules.js +17 -0
- package/dist/broker/alpaca/getAlpacaRules.js.map +1 -0
- package/dist/broker/alpaca/index.d.ts +17 -0
- package/dist/broker/alpaca/index.js +18 -0
- package/dist/broker/alpaca/index.js.map +1 -0
- package/dist/broker/getAuthenticatedBrokerClient.d.ts +4 -0
- package/dist/broker/getAuthenticatedBrokerClient.js +7 -0
- package/dist/broker/getAuthenticatedBrokerClient.js.map +1 -0
- package/dist/broker/getBrokerClient.d.ts +10 -0
- package/dist/broker/getBrokerClient.js +29 -0
- package/dist/broker/getBrokerClient.js.map +1 -0
- package/dist/broker/index.d.ts +6 -0
- package/dist/broker/index.js +7 -0
- package/dist/broker/index.js.map +1 -0
- package/dist/broker/trading212/Trading212Broker.d.ts +41 -0
- package/dist/broker/trading212/Trading212Broker.js +249 -0
- package/dist/broker/trading212/Trading212Broker.js.map +1 -0
- package/dist/broker/trading212/Trading212BrokerMapper.d.ts +10 -0
- package/dist/broker/trading212/Trading212BrokerMapper.js +84 -0
- package/dist/broker/trading212/Trading212BrokerMapper.js.map +1 -0
- package/dist/broker/trading212/api/Trading212API.d.ts +202 -0
- package/dist/broker/trading212/api/Trading212API.js +143 -0
- package/dist/broker/trading212/api/Trading212API.js.map +1 -0
- package/dist/broker/trading212/api/schema/AccountSchema.d.ts +16 -0
- package/dist/broker/trading212/api/schema/AccountSchema.js +15 -0
- package/dist/broker/trading212/api/schema/AccountSchema.js.map +1 -0
- package/dist/broker/trading212/api/schema/HistoryOrderSchema.d.ts +136 -0
- package/dist/broker/trading212/api/schema/HistoryOrderSchema.js +57 -0
- package/dist/broker/trading212/api/schema/HistoryOrderSchema.js.map +1 -0
- package/dist/broker/trading212/api/schema/InstrumentSchema.d.ts +37 -0
- package/dist/broker/trading212/api/schema/InstrumentSchema.js +26 -0
- package/dist/broker/trading212/api/schema/InstrumentSchema.js.map +1 -0
- package/dist/broker/trading212/api/schema/OrderSchema.d.ts +97 -0
- package/dist/broker/trading212/api/schema/OrderSchema.js +61 -0
- package/dist/broker/trading212/api/schema/OrderSchema.js.map +1 -0
- package/dist/broker/trading212/api/schema/PositionSchema.d.ts +14 -0
- package/dist/broker/trading212/api/schema/PositionSchema.js +14 -0
- package/dist/broker/trading212/api/schema/PositionSchema.js.map +1 -0
- package/dist/broker/trading212/getTrading212Client.d.ts +8 -0
- package/dist/broker/trading212/getTrading212Client.js +6 -0
- package/dist/broker/trading212/getTrading212Client.js.map +1 -0
- package/dist/broker/trading212/index.d.ts +4 -0
- package/dist/broker/trading212/index.js +5 -0
- package/dist/broker/trading212/index.js.map +1 -0
- package/dist/candle/BatchedCandle.d.ts +24 -0
- package/dist/candle/BatchedCandle.js +4 -0
- package/dist/candle/BatchedCandle.js.map +1 -0
- package/dist/candle/CandleBatcher.d.ts +35 -0
- package/dist/candle/CandleBatcher.js +233 -0
- package/dist/candle/CandleBatcher.js.map +1 -0
- package/dist/candle/index.d.ts +2 -0
- package/dist/candle/index.js +3 -0
- package/dist/candle/index.js.map +1 -0
- package/dist/candle/writeCandles.d.ts +2 -0
- package/dist/candle/writeCandles.js +5 -0
- package/dist/candle/writeCandles.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/util/SimplifiedHttpError.d.ts +11 -0
- package/dist/util/SimplifiedHttpError.js +17 -0
- package/dist/util/SimplifiedHttpError.js.map +1 -0
- package/dist/util/index.d.ts +1 -0
- package/dist/util/index.js +2 -0
- package/dist/util/index.js.map +1 -0
- package/dist/util/isEarningsDay.d.ts +15 -0
- package/dist/util/isEarningsDay.js +39 -0
- package/dist/util/isEarningsDay.js.map +1 -0
- package/dist/util/simplifyError.d.ts +2 -0
- package/dist/util/simplifyError.js +16 -0
- package/dist/util/simplifyError.js.map +1 -0
- package/package.json +24 -30
- package/dist/index.cjs +0 -967
- package/dist/index.d.cts +0 -361
- package/dist/index.d.mts +0 -361
- package/dist/index.mjs +0 -919
package/README.md
CHANGED
|
@@ -9,3 +9,92 @@ Utilities for handling trading exchange data with proper type safety and aggrega
|
|
|
9
9
|
- **High Precision:** Uses `big.js` for arbitrary-precision decimal arithmetic
|
|
10
10
|
- **Event-Driven:** Built-in EventEmitter for streaming candle updates
|
|
11
11
|
- **Flexible Intervals:** Timeframes using human-readable strings (e.g., "1h", "5m")
|
|
12
|
+
|
|
13
|
+
## Design Decisions
|
|
14
|
+
|
|
15
|
+
The `Broker` interface is intentionally kept generic so that any broker can implement it. This means:
|
|
16
|
+
|
|
17
|
+
- **Bring your own broker.** Alpaca and Trading212 are first-class, but the package is built to be extended.
|
|
18
|
+
- **Extend the abstract `Broker` class** and your integration plugs straight into the `trading-strategies` package's `TradingSession` for live strategies and `BacktestExecutor` for backtesting — both for free, with no extra wiring. See [`BROKER_TEMPLATE.md`](./BROKER_TEMPLATE.md) for the conventions every integration follows.
|
|
19
|
+
- **Extend `MarketDataSource`** to add live-streaming candles for your strategies. If your broker has no market-data API, plug in an existing source (e.g. Alpaca) instead — execution and market data are deliberately separated so they can be mixed and matched.
|
|
20
|
+
|
|
21
|
+
## Alpaca
|
|
22
|
+
|
|
23
|
+
This package includes a first-class [Alpaca](https://alpaca.markets/) implementation.
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import {getAlpacaClient} from '@typedtrader/exchange';
|
|
27
|
+
|
|
28
|
+
const exchange = getAlpacaClient({
|
|
29
|
+
apiKey: process.env.ALPACA_API_KEY,
|
|
30
|
+
apiSecret: process.env.ALPACA_API_SECRET,
|
|
31
|
+
usePaperTrading: true,
|
|
32
|
+
});
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Why Alpaca:**
|
|
36
|
+
|
|
37
|
+
- **Commission-free** US stocks and ETFs, with fractional shares.
|
|
38
|
+
- **Add funds commission-free** with [Revolut](https://www.revolut.com/), avoiding the transfer fees most banks charge.
|
|
39
|
+
- **Free paper trading** that mirrors the live API, so strategies can be validated without risking capital.
|
|
40
|
+
- **Free market data** via the IEX feed, including WebSocket-streamed minute bars (the source this package pairs with other brokers).
|
|
41
|
+
- **Crypto** trades 24/7 alongside equities.
|
|
42
|
+
- **[24/5 trading](https://docs.alpaca.markets/us/docs/245-trading)** of US stocks via an overnight session, so positions can be opened or closed from Sunday evening through Friday evening.
|
|
43
|
+
|
|
44
|
+
**Resources:**
|
|
45
|
+
|
|
46
|
+
- [Alpaca API Reference](https://docs.alpaca.markets/reference/)
|
|
47
|
+
- [Alpaca OpenAPI Files](https://docs.alpaca.markets/openapi)
|
|
48
|
+
- [24/5 Trading](https://docs.alpaca.markets/us/docs/245-trading)
|
|
49
|
+
|
|
50
|
+
## Trading212
|
|
51
|
+
|
|
52
|
+
[Trading212](https://www.trading212.com/) is supported as a broker.
|
|
53
|
+
|
|
54
|
+
**Why Trading212:**
|
|
55
|
+
|
|
56
|
+
- **Commission-free** investing in 13,000+ stocks and ETFs, with fractional shares from £1/€1.
|
|
57
|
+
- **Broad UK, European, and US coverage.**
|
|
58
|
+
- **Multi-currency accounts** for depositing and investing in 13 currencies.
|
|
59
|
+
- **Tax-advantaged Stocks & Shares ISA** (and Cash ISA) for UK residents, with no account fees.
|
|
60
|
+
- **Daily [interest](https://www.trading212.com/interest-on-cash)** paid on uninvested cash.
|
|
61
|
+
|
|
62
|
+
Its API has **no historical bars and no WebSocket**, so `Trading212Broker` requires an external `MarketDataSource` for candle methods.
|
|
63
|
+
|
|
64
|
+
The package separates **execution** (`Broker`) from **market data** (`MarketDataSource`) so any data provider can be paired with any broker. For US equities, Alpaca's market-data feed is the natural pairing as it is free, works with a paper account, and supports WebSocket-streamed minute bars:
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
import {AlpacaMarketData, getTrading212Client, TradingPair} from '@typedtrader/exchange';
|
|
68
|
+
|
|
69
|
+
// 1. Construct an Alpaca-backed market-data source.
|
|
70
|
+
const marketData = new AlpacaMarketData({
|
|
71
|
+
apiKey: 'ALPACA_API_KEY',
|
|
72
|
+
apiSecret: 'ALPACA_API_SECRET',
|
|
73
|
+
usePaperTrading: false, // read-only; doesn't place orders
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
// 2. Wire it into the Trading212 broker.
|
|
77
|
+
const broker = getTrading212Client({
|
|
78
|
+
apiKey: 'TRADING212_API_KEY',
|
|
79
|
+
apiSecret: 'TRADING212_API_SECRET',
|
|
80
|
+
usePaperTrading: true,
|
|
81
|
+
marketData, // required — Trading212 has no candles of its own
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
// 3. Use the broker as if it provided everything natively. Symbol mapping is automatic:
|
|
85
|
+
// Trading212's `AAPL_US_EQ` is stripped to Alpaca's `AAPL` behind the scenes.
|
|
86
|
+
const pair = new TradingPair('AAPL_US_EQ', 'USD');
|
|
87
|
+
const latest = await broker.getLatestCandle(pair, 60_000); // → from Alpaca's WebSocket
|
|
88
|
+
await broker.placeLimitOrder(pair, {side: 'BUY', size: '1', price: latest.close}); // → Trading212
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
**Caveats:**
|
|
92
|
+
|
|
93
|
+
- **Coverage mismatch.** Alpaca's free IEX feed covers US equities (and crypto). Trading212's universe includes European and UK instruments that Alpaca doesn't have data for; those tickers will fail at `getCandles` even though Trading212 can trade them. Pair with a different data source (Bloomberg, Polygon, EODHD, Twelve Data) for non-US coverage.
|
|
94
|
+
- **Cross-currency fees.** Trading212 debits a currency-conversion fee on cross-currency trades (e.g. a EUR account buying USD instruments) at ~0.15% per leg. `Trading212Broker.getFeeRates()` surfaces this as `CURRENCY_CONVERSION_FEE`; `estimateFee()` includes it in the total so strategies can subtract round-trip costs before deciding to enter.
|
|
95
|
+
- **No order-stream WebSocket.** `watchOrders` is implemented by polling `/api/v0/equity/history/orders` once per minute (matching Trading212's documented rate limit). Latency therefore equals the poll interval; fills arrive within ~60 seconds rather than push-style.
|
|
96
|
+
|
|
97
|
+
**Resources:**
|
|
98
|
+
|
|
99
|
+
- [Trading212 API Documentation](https://docs.trading212.com/api)
|
|
100
|
+
- [Trading212 Help Centre — Fees](https://helpcentre.trading212.com/hc/en-us/articles/11471996799517)
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import Big from 'big.js';
|
|
2
|
+
import { EventEmitter } from 'node:events';
|
|
3
|
+
import type { TradingPair } from './TradingPair.js';
|
|
4
|
+
import { z } from 'zod';
|
|
5
|
+
export declare const OrderSide: {
|
|
6
|
+
readonly BUY: "BUY";
|
|
7
|
+
readonly SELL: "SELL";
|
|
8
|
+
};
|
|
9
|
+
export type OrderSide = (typeof OrderSide)[keyof typeof OrderSide];
|
|
10
|
+
interface OrderBase {
|
|
11
|
+
side: OrderSide;
|
|
12
|
+
size: string;
|
|
13
|
+
type: OrderType;
|
|
14
|
+
}
|
|
15
|
+
export declare const CandleBaseSchema: z.ZodObject<{
|
|
16
|
+
base: z.ZodString;
|
|
17
|
+
counter: z.ZodString;
|
|
18
|
+
isLatest: z.ZodOptional<z.ZodBoolean>;
|
|
19
|
+
openTimeInISO: z.ZodString;
|
|
20
|
+
openTimeInMillis: z.ZodNumber;
|
|
21
|
+
sizeInMillis: z.ZodNumber;
|
|
22
|
+
}, z.core.$strip>;
|
|
23
|
+
export type CandleBase = z.infer<typeof CandleBaseSchema>;
|
|
24
|
+
export declare const OrderType: {
|
|
25
|
+
readonly LIMIT: "LIMIT";
|
|
26
|
+
readonly MARKET: "MARKET";
|
|
27
|
+
};
|
|
28
|
+
export type OrderType = (typeof OrderType)[keyof typeof OrderType];
|
|
29
|
+
export declare const CandleSchema: z.ZodObject<{
|
|
30
|
+
close: z.ZodString;
|
|
31
|
+
closeAsk: z.ZodOptional<z.ZodString>;
|
|
32
|
+
high: z.ZodString;
|
|
33
|
+
highAsk: z.ZodOptional<z.ZodString>;
|
|
34
|
+
low: z.ZodString;
|
|
35
|
+
lowAsk: z.ZodOptional<z.ZodString>;
|
|
36
|
+
open: z.ZodString;
|
|
37
|
+
openAsk: z.ZodOptional<z.ZodString>;
|
|
38
|
+
volume: z.ZodString;
|
|
39
|
+
base: z.ZodString;
|
|
40
|
+
counter: z.ZodString;
|
|
41
|
+
isLatest: z.ZodOptional<z.ZodBoolean>;
|
|
42
|
+
openTimeInISO: z.ZodString;
|
|
43
|
+
openTimeInMillis: z.ZodNumber;
|
|
44
|
+
sizeInMillis: z.ZodNumber;
|
|
45
|
+
}, z.core.$strip>;
|
|
46
|
+
export type Candle = z.infer<typeof CandleSchema>;
|
|
47
|
+
export interface CandleImportRequest {
|
|
48
|
+
intervalInMillis: number;
|
|
49
|
+
startTimeFirstCandle: string;
|
|
50
|
+
startTimeLastCandle: string;
|
|
51
|
+
}
|
|
52
|
+
export interface FeeRate {
|
|
53
|
+
LIMIT: Big;
|
|
54
|
+
MARKET: Big;
|
|
55
|
+
CURRENCY_CONVERSION_FEE?: Big;
|
|
56
|
+
}
|
|
57
|
+
export declare const OrderPosition: {
|
|
58
|
+
readonly LONG: "LONG";
|
|
59
|
+
readonly SHORT: "SHORT";
|
|
60
|
+
};
|
|
61
|
+
export type OrderPosition = (typeof OrderPosition)[keyof typeof OrderPosition];
|
|
62
|
+
export interface Fill {
|
|
63
|
+
created_at: string;
|
|
64
|
+
fee: string;
|
|
65
|
+
feeAsset: string;
|
|
66
|
+
order_id: string;
|
|
67
|
+
pair: TradingPair;
|
|
68
|
+
position: OrderPosition;
|
|
69
|
+
price: string;
|
|
70
|
+
side: OrderSide;
|
|
71
|
+
size: string;
|
|
72
|
+
}
|
|
73
|
+
export interface ExchangePendingOrderBase {
|
|
74
|
+
id: string;
|
|
75
|
+
pair: TradingPair;
|
|
76
|
+
side: OrderSide;
|
|
77
|
+
size: string;
|
|
78
|
+
type: OrderType;
|
|
79
|
+
}
|
|
80
|
+
export interface PendingLimitOrder extends ExchangePendingOrderBase {
|
|
81
|
+
price: string;
|
|
82
|
+
type: 'LIMIT';
|
|
83
|
+
}
|
|
84
|
+
export interface PendingMarketOrder extends ExchangePendingOrderBase {
|
|
85
|
+
type: 'MARKET';
|
|
86
|
+
sizeInCounter?: boolean;
|
|
87
|
+
}
|
|
88
|
+
export interface MarketOrderOptions extends OrderBase {
|
|
89
|
+
sizeInCounter: boolean;
|
|
90
|
+
type: 'MARKET';
|
|
91
|
+
}
|
|
92
|
+
export interface LimitOrderOptions extends OrderBase {
|
|
93
|
+
price: string;
|
|
94
|
+
sizeInCounter: false;
|
|
95
|
+
type: 'LIMIT';
|
|
96
|
+
}
|
|
97
|
+
export type OrderOptions = MarketOrderOptions | LimitOrderOptions;
|
|
98
|
+
export type PendingOrder = PendingLimitOrder | PendingMarketOrder;
|
|
99
|
+
export interface Balance {
|
|
100
|
+
available: string;
|
|
101
|
+
currency: string;
|
|
102
|
+
hold: string;
|
|
103
|
+
position: OrderPosition;
|
|
104
|
+
}
|
|
105
|
+
export interface ExchangeAvailableBalance {
|
|
106
|
+
base: Big;
|
|
107
|
+
counter: Big;
|
|
108
|
+
}
|
|
109
|
+
export interface TradingRules {
|
|
110
|
+
base_increment: string;
|
|
111
|
+
base_max_size: string;
|
|
112
|
+
base_min_size: string;
|
|
113
|
+
counter_increment: string;
|
|
114
|
+
counter_min_size: string;
|
|
115
|
+
pair: TradingPair;
|
|
116
|
+
}
|
|
117
|
+
export declare abstract class Broker extends EventEmitter {
|
|
118
|
+
loggerName: string;
|
|
119
|
+
constructor(loggerName: string);
|
|
120
|
+
static toExchangeOrderSide(baseBalance: Big.BigSource, counterBalance: Big.BigSource, priceInCounter: Big.BigSource): OrderSide;
|
|
121
|
+
abstract listBalances(): Promise<Balance[]>;
|
|
122
|
+
abstract cancelOpenOrders(pair: TradingPair): Promise<string[]>;
|
|
123
|
+
abstract cancelOrderById(pair: TradingPair, orderId: string): Promise<void>;
|
|
124
|
+
abstract getOpenOrders(pair: TradingPair): Promise<PendingOrder[]>;
|
|
125
|
+
getLatestFill(pair: TradingPair, side: OrderSide): Promise<Fill | undefined>;
|
|
126
|
+
abstract getFills(pair: TradingPair): Promise<Fill[]>;
|
|
127
|
+
abstract getFillByOrderId(pair: TradingPair, orderId: string): Promise<Fill | undefined>;
|
|
128
|
+
abstract watchOrders(): Promise<string>;
|
|
129
|
+
abstract unwatchOrders(topicId: string): void;
|
|
130
|
+
abstract getTradingRules(pair: TradingPair): Promise<TradingRules>;
|
|
131
|
+
abstract getFeeRates(pair: TradingPair): Promise<FeeRate>;
|
|
132
|
+
getFeeRate(pair: TradingPair, orderType: OrderType): Promise<Big>;
|
|
133
|
+
estimateFee(pair: TradingPair, orderType: OrderType, notional: Big): Promise<{
|
|
134
|
+
commission: Big;
|
|
135
|
+
currencyConversion: Big;
|
|
136
|
+
total: Big;
|
|
137
|
+
feeAsset: string;
|
|
138
|
+
}>;
|
|
139
|
+
protected getFeeAsset(pair: TradingPair): Promise<string>;
|
|
140
|
+
getAvailableBalances(pair: TradingPair): Promise<ExchangeAvailableBalance>;
|
|
141
|
+
abstract getTime(): Promise<string>;
|
|
142
|
+
verifyCredentials(): Promise<void>;
|
|
143
|
+
protected abstract placeOrder(pair: TradingPair, options: LimitOrderOptions): Promise<PendingLimitOrder>;
|
|
144
|
+
protected abstract placeOrder(pair: TradingPair, options: MarketOrderOptions): Promise<PendingMarketOrder>;
|
|
145
|
+
protected abstract placeOrder(pair: TradingPair, options: OrderOptions): Promise<PendingOrder>;
|
|
146
|
+
placeLimitOrder(pair: TradingPair, options: Omit<LimitOrderOptions, 'type' | 'sizeInCounter'>): Promise<PendingLimitOrder>;
|
|
147
|
+
placeMarketOrder(pair: TradingPair, options: Omit<MarketOrderOptions, 'type'>): Promise<PendingMarketOrder>;
|
|
148
|
+
abstract disconnect(): void;
|
|
149
|
+
abstract getName(): string;
|
|
150
|
+
abstract getSmallestInterval(): number;
|
|
151
|
+
}
|
|
152
|
+
export {};
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import Big from 'big.js';
|
|
2
|
+
import { EventEmitter } from 'node:events';
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
export const OrderSide = {
|
|
5
|
+
BUY: 'BUY',
|
|
6
|
+
SELL: 'SELL',
|
|
7
|
+
};
|
|
8
|
+
export const CandleBaseSchema = z.object({
|
|
9
|
+
base: z.string(),
|
|
10
|
+
counter: z.string(),
|
|
11
|
+
isLatest: z.boolean().optional(),
|
|
12
|
+
openTimeInISO: z.string(),
|
|
13
|
+
openTimeInMillis: z.number(),
|
|
14
|
+
sizeInMillis: z.number(),
|
|
15
|
+
});
|
|
16
|
+
export const OrderType = {
|
|
17
|
+
LIMIT: 'LIMIT',
|
|
18
|
+
MARKET: 'MARKET',
|
|
19
|
+
};
|
|
20
|
+
export const CandleSchema = z
|
|
21
|
+
.object({
|
|
22
|
+
close: z.string(),
|
|
23
|
+
closeAsk: z.string().optional(),
|
|
24
|
+
high: z.string(),
|
|
25
|
+
highAsk: z.string().optional(),
|
|
26
|
+
low: z.string(),
|
|
27
|
+
lowAsk: z.string().optional(),
|
|
28
|
+
open: z.string(),
|
|
29
|
+
openAsk: z.string().optional(),
|
|
30
|
+
volume: z.string(),
|
|
31
|
+
})
|
|
32
|
+
.merge(CandleBaseSchema);
|
|
33
|
+
export const OrderPosition = {
|
|
34
|
+
LONG: 'LONG',
|
|
35
|
+
SHORT: 'SHORT',
|
|
36
|
+
};
|
|
37
|
+
export class Broker extends EventEmitter {
|
|
38
|
+
loggerName;
|
|
39
|
+
constructor(loggerName) {
|
|
40
|
+
super();
|
|
41
|
+
this.loggerName = loggerName;
|
|
42
|
+
}
|
|
43
|
+
static toExchangeOrderSide(baseBalance, counterBalance, priceInCounter) {
|
|
44
|
+
const currentBaseWorthInCounter = new Big(baseBalance).mul(priceInCounter);
|
|
45
|
+
const currentCounterWorthInCounter = new Big(counterBalance);
|
|
46
|
+
if (currentBaseWorthInCounter.gt(currentCounterWorthInCounter)) {
|
|
47
|
+
return OrderSide.BUY;
|
|
48
|
+
}
|
|
49
|
+
return OrderSide.SELL;
|
|
50
|
+
}
|
|
51
|
+
async getLatestFill(pair, side) {
|
|
52
|
+
const fills = await this.getFills(pair);
|
|
53
|
+
const fill = fills.find(fill => fill.side === side);
|
|
54
|
+
if (fill) {
|
|
55
|
+
return fill;
|
|
56
|
+
}
|
|
57
|
+
return undefined;
|
|
58
|
+
}
|
|
59
|
+
async getFeeRate(pair, orderType) {
|
|
60
|
+
const feeRate = await this.getFeeRates(pair);
|
|
61
|
+
return feeRate[orderType];
|
|
62
|
+
}
|
|
63
|
+
async estimateFee(pair, orderType, notional) {
|
|
64
|
+
const rates = await this.getFeeRates(pair);
|
|
65
|
+
const commission = notional.times(rates[orderType]);
|
|
66
|
+
const conversionRate = rates.CURRENCY_CONVERSION_FEE;
|
|
67
|
+
const currencyConversion = conversionRate ? notional.times(conversionRate) : new Big(0);
|
|
68
|
+
return {
|
|
69
|
+
commission,
|
|
70
|
+
currencyConversion,
|
|
71
|
+
feeAsset: await this.getFeeAsset(pair),
|
|
72
|
+
total: commission.plus(currencyConversion),
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
async getFeeAsset(pair) {
|
|
76
|
+
return pair.counter;
|
|
77
|
+
}
|
|
78
|
+
async getAvailableBalances(pair) {
|
|
79
|
+
const balances = await this.listBalances();
|
|
80
|
+
let baseBalance = balances.find(balance => balance.currency === pair.base);
|
|
81
|
+
let counterBalance = balances.find(balance => balance.currency === pair.counter);
|
|
82
|
+
if (!baseBalance) {
|
|
83
|
+
baseBalance = {
|
|
84
|
+
available: '0',
|
|
85
|
+
currency: pair.base,
|
|
86
|
+
hold: '0',
|
|
87
|
+
position: OrderPosition.LONG,
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
if (!counterBalance) {
|
|
91
|
+
counterBalance = {
|
|
92
|
+
available: '0',
|
|
93
|
+
currency: pair.counter,
|
|
94
|
+
hold: '0',
|
|
95
|
+
position: OrderPosition.LONG,
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
base: new Big(baseBalance.available),
|
|
100
|
+
counter: new Big(counterBalance.available),
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
async verifyCredentials() {
|
|
104
|
+
await this.getTime();
|
|
105
|
+
}
|
|
106
|
+
placeLimitOrder(pair, options) {
|
|
107
|
+
return this.placeOrder(pair, {
|
|
108
|
+
price: options.price,
|
|
109
|
+
side: options.side,
|
|
110
|
+
size: options.size,
|
|
111
|
+
sizeInCounter: false,
|
|
112
|
+
type: OrderType.LIMIT,
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
placeMarketOrder(pair, options) {
|
|
116
|
+
return this.placeOrder(pair, {
|
|
117
|
+
side: options.side,
|
|
118
|
+
size: options.size,
|
|
119
|
+
sizeInCounter: options.sizeInCounter,
|
|
120
|
+
type: OrderType.MARKET,
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
//# sourceMappingURL=Broker.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Broker.js","sourceRoot":"","sources":["../../src/broker/Broker.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,QAAQ,CAAC;AACzB,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AASX,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAEvC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAGhB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IAGnB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEhC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IAEzB,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAE5B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,SAAS,GAAG;IAEvB,KAAK,EAAE,OAAO;IAEd,MAAM,EAAE,QAAQ;CACR,CAAC;AAGX,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IAEN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IAEjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAEhB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE9B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IAEf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAEhB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC;KACD,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAgC3B,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACN,CAAC;AA4FX,MAAM,OAAgB,MAAO,SAAQ,YAAY;IAC/C,UAAU,CAAS;IAEnB,YAAY,UAAkB;QAC5B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAUD,MAAM,CAAC,mBAAmB,CACxB,WAA0B,EAC1B,cAA6B,EAC7B,cAA6B;QAE7B,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC3E,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAC7D,IAAI,yBAAyB,CAAC,EAAE,CAAC,4BAA4B,CAAC,EAAE,CAAC;YAC/D,OAAO,SAAS,CAAC,GAAG,CAAC;QACvB,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC;IACxB,CAAC;IA4BD,KAAK,CAAC,aAAa,CAAC,IAAiB,EAAE,IAAe;QACpD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAEpD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IA6CD,KAAK,CAAC,UAAU,CAAC,IAAiB,EAAE,SAAoB;QACtD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAaD,KAAK,CAAC,WAAW,CACf,IAAiB,EACjB,SAAoB,EACpB,QAAa;QAEb,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACpD,MAAM,cAAc,GAAG,KAAK,CAAC,uBAAuB,CAAC;QACrD,MAAM,kBAAkB,GAAG,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;QACxF,OAAO;YACL,UAAU;YACV,kBAAkB;YAClB,QAAQ,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YACtC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC;SAC3C,CAAC;IACJ,CAAC;IAOS,KAAK,CAAC,WAAW,CAAC,IAAiB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAKD,KAAK,CAAC,oBAAoB,CAAC,IAAiB;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAE3C,IAAI,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC;QAEjF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG;gBACZ,SAAS,EAAE,GAAG;gBACd,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,aAAa,CAAC,IAAI;aAC7B,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG;gBACf,SAAS,EAAE,GAAG;gBACd,QAAQ,EAAE,IAAI,CAAC,OAAO;gBACtB,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,aAAa,CAAC,IAAI;aAC7B,CAAC;QACJ,CAAC;QAED,OAAO;YACL,IAAI,EAAE,IAAI,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC;YACpC,OAAO,EAAE,IAAI,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC;SAC3C,CAAC;IACJ,CAAC;IAcD,KAAK,CAAC,iBAAiB;QACrB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAcD,eAAe,CACb,IAAiB,EACjB,OAA0D;QAE1D,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC3B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,aAAa,EAAE,KAAK;YACpB,IAAI,EAAE,SAAS,CAAC,KAAK;SACtB,CAAC,CAAC;IACL,CAAC;IAMD,gBAAgB,CAAC,IAAiB,EAAE,OAAyC;QAC3E,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAC3B,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,IAAI,EAAE,SAAS,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;CAgBF"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import Big from 'big.js';
|
|
2
|
+
import { Broker, type Balance, type Candle, type FeeRate, type Fill, type LimitOrderOptions, type MarketOrderOptions, type PendingLimitOrder, type PendingMarketOrder, type PendingOrder, type TradingRules } from './Broker.js';
|
|
3
|
+
import type { TradingPair } from './TradingPair.js';
|
|
4
|
+
export interface ExchangeMockBalance {
|
|
5
|
+
available: Big;
|
|
6
|
+
hold: Big;
|
|
7
|
+
}
|
|
8
|
+
export declare abstract class BrokerMock extends Broker {
|
|
9
|
+
#private;
|
|
10
|
+
constructor(config: {
|
|
11
|
+
balances: Map<string, ExchangeMockBalance>;
|
|
12
|
+
});
|
|
13
|
+
setHistoricalCandles(candles: Candle[]): void;
|
|
14
|
+
getRecentCandles(_pair: TradingPair, count: number, _intervalInMillis: number): Promise<Candle[]>;
|
|
15
|
+
abstract getFeeRates(pair: TradingPair): Promise<FeeRate>;
|
|
16
|
+
abstract getTradingRules(pair: TradingPair): Promise<TradingRules>;
|
|
17
|
+
abstract getName(): string;
|
|
18
|
+
abstract getSmallestInterval(): number;
|
|
19
|
+
processCandle(candle: Candle): Fill[];
|
|
20
|
+
protected placeOrder(pair: TradingPair, options: LimitOrderOptions): Promise<PendingLimitOrder>;
|
|
21
|
+
protected placeOrder(pair: TradingPair, options: MarketOrderOptions): Promise<PendingMarketOrder>;
|
|
22
|
+
setCachedFeeRates(rates: FeeRate): void;
|
|
23
|
+
listBalances(): Promise<Balance[]>;
|
|
24
|
+
getFills(pair: TradingPair): Promise<Fill[]>;
|
|
25
|
+
getFillByOrderId(_pair: TradingPair, orderId: string): Promise<Fill | undefined>;
|
|
26
|
+
cancelOrderById(_pair: TradingPair, orderId: string): Promise<void>;
|
|
27
|
+
cancelOpenOrders(pair: TradingPair): Promise<string[]>;
|
|
28
|
+
getLatestCandle(_pair: TradingPair, _intervalInMillis: number): Promise<{
|
|
29
|
+
close: string;
|
|
30
|
+
high: string;
|
|
31
|
+
low: string;
|
|
32
|
+
open: string;
|
|
33
|
+
volume: string;
|
|
34
|
+
base: string;
|
|
35
|
+
counter: string;
|
|
36
|
+
openTimeInISO: string;
|
|
37
|
+
openTimeInMillis: number;
|
|
38
|
+
sizeInMillis: number;
|
|
39
|
+
closeAsk?: string | undefined;
|
|
40
|
+
highAsk?: string | undefined;
|
|
41
|
+
lowAsk?: string | undefined;
|
|
42
|
+
openAsk?: string | undefined;
|
|
43
|
+
isLatest?: boolean | undefined;
|
|
44
|
+
}>;
|
|
45
|
+
getTime(): Promise<string>;
|
|
46
|
+
getOpenOrders(pair: TradingPair): Promise<PendingOrder[]>;
|
|
47
|
+
watchOrders(): Promise<`${string}-${string}-${string}-${string}-${string}`>;
|
|
48
|
+
unwatchOrders(topicId: string): void;
|
|
49
|
+
disconnect(): void;
|
|
50
|
+
getPendingOrders(): PendingOrder[];
|
|
51
|
+
}
|