@trinaryex/sdk 1.0.0 → 2.0.0

package/README.md

@@ -1,9 +1,18 @@
 # @trinaryex/sdk
 
-The trading SDK for **Trinary Exchange** — a Sui-based, DeepBook-style market
-for the EVE Frontier game economy. Players and bots read market + account data
-through the [Trinary Exchange API](https://api.trinary.exchange) and trade by
-signing on-chain transactions with their own wallet or keypair.
+[![npm version](https://img.shields.io/npm/v/%40trinaryex%2Fsdk)](https://www.npmjs.com/package/@trinaryex/sdk)
+[![license: MIT](https://img.shields.io/npm/l/%40trinaryex%2Fsdk)](#license)
+
+The official TypeScript trading SDK for
+[**Trinary Exchange**](https://trinary.exchange/), the player-built
+**EVE Frontier marketplace** — a Sui-based, DeepBook-style order-book market
+for trading items and currency across EVE Frontier trade hubs. Players and
+bots read live **EVE Frontier market data** through the
+[Trinary Exchange API](https://docs.trinary.exchange/) and trade by signing
+on-chain transactions with their own wallet or keypair.
+
+- 🛰️ Browse the markets: **<https://trinary.exchange/>**
+- 📚 Full API documentation: **<https://docs.trinary.exchange/>**
 
 Built for exactly the things you'd want to build on an exchange:
 
@@ -12,9 +21,10 @@ Built for exactly the things you'd want to build on an exchange:
 - **CLI tools** — everything is plain async TypeScript with typed errors
 - **agentic trading** — stable error codes plus human-readable on-chain abort translation
 
-> **Status: pre-release.** Reads and the full write surface (deposits,
-> withdrawals, orders, cancels, claims) are implemented and unit-tested
-> against the production app's transaction composition. Targets **testnet**
+> **Status: v1.0.0 — released.** The full read and write surface (deposits,
+> withdrawals, orders, cancels, claims) is verified end-to-end against the
+> live gateway and chain: a scripted trading lifecycle with real fills, fees,
+> and settled-proceeds claims, on top of 93 unit tests. Targets **testnet**
 > (the `stillness` world). See [DESIGN.md](./DESIGN.md).
 
 ## Two planes, two auth models
@@ -98,7 +108,7 @@ const feed = await ro.discover({ assetId: '70810', side: 'sell' })
 ### Market analytics
 
 ```ts
-import { aggregateLevels, midPrice, spread, vwap, bucketTrades, iterateTrades } from '@trinaryex/sdk'
+import { aggregateLevels, midPrice, spread, vwap, iterateTrades } from '@trinaryex/sdk'
 
 const book = await ro.orderbook({ storageUnitId, assetId })
 console.log('mid', midPrice(book), 'spread', spread(book)?.bps, 'bps')
@@ -109,9 +119,8 @@ const history = []
 for await (const trade of iterateTrades(ro.indexer, balanceManagerId)) {
   history.push(trade) // { price, baseQuantity, quoteQuantity, fee, side, tradedAt, … }
 }
-// … and chart it: the API has no price-history endpoint, so build candles
-// client-side.
-const hourly = bucketTrades(history, 60 * 60 * 1000) // OHLCV Candle[]
+// … and summarize it.
+console.log('lifetime VWAP', vwap(history))
 ```
 
 ### Trading bot loop
@@ -197,7 +206,7 @@ explainMoveAbort(rawError) // "No liquidity available (EEmptyOrderbook)" | null
 | `balances` | `atHub` (items: warehouse/marketplace/hangar) · `currency` (CRED wallet + BM, fullnode) |
 | `market` | `discover` · `hub` · `itemsAtHub` · `resolvePool` · `orderbook` · `poolMetadata` |
 | `orders` | `limit` · `market` · `cancel` · `cancelAll` · `modify` · `openOrders` · `fills` · `trades` |
-| helpers | `aggregateLevels` · `midPrice` · `spread` · `depth` · `vwap` · `bucketTrades` (OHLCV) · `estimateMarketBuyCost` · `iterateDiscovery/Fills/Trades` · `untilIndexed` · `explainMoveAbort` · `toBase` / `fromBase` |
+| helpers | `aggregateLevels` · `midPrice` · `spread` · `depth` · `vwap` · `estimateMarketBuyCost` · `iterateDiscovery/Fills/Trades` · `untilIndexed` · `explainMoveAbort` · `toBase` / `fromBase` |
 
 Runnable examples live in [`examples/`](./examples).
 
@@ -226,7 +235,7 @@ slots) from the **fullnode**, head-current. Prefer ids returned from writes
 
 ```bash
 npm install
-npm run tscheck && npm test          # 70 unit tests
+npm run tscheck && npm test          # 93 unit tests
 npm run build
 
 # Live verification (needs .env — see .env.sample):
@@ -234,6 +243,17 @@ node --env-file=.env scripts/smoke.mjs        # read surface vs the live gateway
 node --env-file=.env scripts/integration.mjs  # write paths on testnet (uses gas)
 ```
 
+## Links
+
+- [Trinary Exchange](https://trinary.exchange/) — the EVE Frontier
+  marketplace: live order books, trade hubs, and market data for the EVE
+  Frontier economy
+- [API documentation](https://docs.trinary.exchange/) — REST reference,
+  guides, and [API keys](https://docs.trinary.exchange/docs/api-keys) for the
+  Trinary Exchange trading API
+- [`@trinaryex/sdk` on npm](https://www.npmjs.com/package/@trinaryex/sdk)
+- [Design notes](./DESIGN.md) — architecture, scope, and verification history
+
 ## License
 
 MIT

package/dist/book.d.ts

@@ -14,14 +14,3 @@ export declare function spread(book: Orderbook): {
 } | null;
 export declare function depth(orders: OrderbookOrder[]): bigint;
 export declare function vwap(executions: ReadonlyArray<Pick<Fill | Trade, 'baseQuantity' | 'quoteQuantity'>>): bigint | null;
-export interface Candle {
-    openTime: number;
-    open: bigint;
-    high: bigint;
-    low: bigint;
-    close: bigint;
-    baseVolume: bigint;
-    quoteVolume: bigint;
-    tradeCount: number;
-}
-export declare function bucketTrades(trades: ReadonlyArray<Pick<Trade, 'price' | 'baseQuantity' | 'quoteQuantity' | 'tradedAt'>>, intervalMs: number): Candle[];

package/dist/index.d.ts

@@ -10,8 +10,8 @@ export { getWalletCurrencyBalance, getBalanceManagerCurrencyBalance, getBalanceM
 export { prepareWalletCoinInput, sourceItemsIntoBalanceManager, } from './funding';
 export { normalizeExecuteResult, executeAndNormalize, findCreatedObject, } from './execute';
 export type { NormalizedExecution, CreatedObject } from './execute';
-export { aggregateLevels, bestBid, bestAsk, midPrice, spread, depth, vwap, bucketTrades, } from './book';
-export type { BookLevel, Candle } from './book';
+export { aggregateLevels, bestBid, bestAsk, midPrice, spread, depth, vwap, } from './book';
+export type { BookLevel } from './book';
 export { iterateDiscovery, iterateFills, iterateTrades } from './paging';
 export type { IterateOptions } from './paging';
 export { untilIndexed } from './wait';

package/dist/index.js

@@ -1537,27 +1537,9 @@ function Xe(e) {
 	for (let r of e) t += r.baseQuantity, n += r.quoteQuantity;
 	return t === 0n ? null : n / t;
 }
-function Ze(e, t) {
-	if (t <= 0) throw Error("intervalMs must be positive");
-	let n = [...e].sort((e, t) => e.tradedAt - t.tradedAt), r = [];
-	for (let e of n) {
-		let n = Math.floor(e.tradedAt / t) * t, i = r[r.length - 1];
-		i && i.openTime === n ? (e.price > i.high && (i.high = e.price), e.price < i.low && (i.low = e.price), i.close = e.price, i.baseVolume += e.baseQuantity, i.quoteVolume += e.quoteQuantity, i.tradeCount++) : r.push({
-			openTime: n,
-			open: e.price,
-			high: e.price,
-			low: e.price,
-			close: e.price,
-			baseVolume: e.baseQuantity,
-			quoteVolume: e.quoteQuantity,
-			tradeCount: 1
-		});
-	}
-	return r;
-}
 //#endregion
 //#region src/paging.ts
-async function* Qe(e, t, n) {
+async function* Ze(e, t, n) {
 	let r = n?.maxItems ?? 1e4, i = t?.cursor, a = 0;
 	for (;;) {
 		let n = await e.discovery({
@@ -1569,7 +1551,7 @@ async function* Qe(e, t, n) {
 		i = n.nextCursor;
 	}
 }
-async function* $e(e, t, n, r) {
+async function* Qe(e, t, n, r) {
 	let i = r?.maxItems ?? 1e4, a = n?.before, o = 0;
 	for (;;) {
 		let r = await e.fills(t, {
@@ -1581,7 +1563,7 @@ async function* $e(e, t, n, r) {
 		a = r.fills[r.fills.length - 1].filledAt;
 	}
 }
-async function* et(e, t, n, r) {
+async function* $e(e, t, n, r) {
 	let i = r?.maxItems ?? 1e4, a = n?.before, o = 0;
 	for (;;) {
 		let r = await e.trades(t, {
@@ -1595,7 +1577,7 @@ async function* et(e, t, n, r) {
 }
 //#endregion
 //#region src/wait.ts
-async function tt(e, t) {
+async function et(e, t) {
 	let n = t?.timeoutMs ?? 3e4, r = t?.intervalMs ?? 2e3, i = Date.now() + n;
 	for (;;) {
 		let a = await e();
@@ -1605,4 +1587,4 @@ async function tt(e, t) {
 	}
 }
 //#endregion
-export { o as CLOCK_ID, a as DEFAULT_INDEXER_URL, W as FEE_RATE_SCALING, fe as GTC_EXPIRE, X as IndexerClient, U as MULTICOIN_PRICE_SCALING, c as NETWORK_PRESETS, Ge as ReadOnlyClient, s as STILLNESS_PACKAGE_IDS, de as TRIEXBOOK_PRICE_SCALING, ze as TriexClient, d as TriexClientError, u as TriexError, Ke as aggregateLevels, $ as bestAsk, Q as bestBid, Ze as bucketTrades, K as computeBidQuoteDeposit, G as computeItemQuote, Ye as depth, ge as estimateMarketBuyCost, m as executeAndNormalize, p as explainMoveAbort, O as fetchCharacterInfo, A as fetchInventorySlotQuantity, k as fetchSsuOwnerInfo, g as findCreatedObject, D as findOwnedItemReceipts, me as fromBase, T as getBalanceManagerCurrencyBalance, ie as getBalanceManagerItemBalance, ne as getObjectRef, E as getRegistryMulticoinCollectionId, re as getWalletCurrencyBalance, Qe as iterateDiscovery, $e as iterateFills, et as iterateTrades, he as marketBuyRoundingBuffer, qe as midPrice, h as normalizeExecuteResult, V as prepareWalletCoinInput, l as resolvePackageIds, H as sourceItemsIntoBalanceManager, Je as spread, pe as toBase, w as toSsuObjectId, ae as transactions, tt as untilIndexed, Xe as vwap };
+export { o as CLOCK_ID, a as DEFAULT_INDEXER_URL, W as FEE_RATE_SCALING, fe as GTC_EXPIRE, X as IndexerClient, U as MULTICOIN_PRICE_SCALING, c as NETWORK_PRESETS, Ge as ReadOnlyClient, s as STILLNESS_PACKAGE_IDS, de as TRIEXBOOK_PRICE_SCALING, ze as TriexClient, d as TriexClientError, u as TriexError, Ke as aggregateLevels, $ as bestAsk, Q as bestBid, K as computeBidQuoteDeposit, G as computeItemQuote, Ye as depth, ge as estimateMarketBuyCost, m as executeAndNormalize, p as explainMoveAbort, O as fetchCharacterInfo, A as fetchInventorySlotQuantity, k as fetchSsuOwnerInfo, g as findCreatedObject, D as findOwnedItemReceipts, me as fromBase, T as getBalanceManagerCurrencyBalance, ie as getBalanceManagerItemBalance, ne as getObjectRef, E as getRegistryMulticoinCollectionId, re as getWalletCurrencyBalance, Ze as iterateDiscovery, Qe as iterateFills, $e as iterateTrades, he as marketBuyRoundingBuffer, qe as midPrice, h as normalizeExecuteResult, V as prepareWalletCoinInput, l as resolvePackageIds, H as sourceItemsIntoBalanceManager, Je as spread, pe as toBase, w as toSsuObjectId, ae as transactions, et as untilIndexed, Xe as vwap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trinaryex/sdk",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Trading SDK for Trinary Exchange — market data, order books, and on-chain trading (Sui) for bots, analytics tools, and CLIs.",
   "type": "module",
   "main": "dist/index.js",
@@ -98,6 +98,12 @@
     "sui",
     "orderbook",
     "eve-frontier",
+    "eve-frontier-trading",
+    "eve-frontier-market",
+    "eve-frontier-marketplace",
+    "marketplace",
+    "market-data",
+    "trading-bot",
     "deepbook"
   ],
   "sideEffects": false,